VoicePlan-Webservices

VoiceCheck stellt einen Webservice bereit, mit dem ein VoicePlan erstellt werden kann, der im Grunde nichts anderes als ein Datenimport ist. Mit diesem Webservice können sowohl neue VoicePlans erstellt als auch vorhandene VoicePlans aktualisiert und vom VoiceCheck-Server gelöscht werden. Wenn dieser Webservice aufgerufen wird, validiert VoiceCheck das System und prüft Folgendes:

  • Wenn kein passender VoicePlan-Name vorhanden ist, wird ein neuer VoicePlan erstellt.
  • Wenn ein passender VoicePlan-Name vorhanden ist, wird kein neuer VoicePlan erstellt.
  • Ein VoicePlan ohne Beschreibung, VoiceForm und Abschnittsschritte gilt als ungültig und nicht erstellt.
  • Wenn das mit dem VoicePlan verknüpfte VoiceForm auf dem VoiceCheck-Server nicht gefunden wird, wird kein VoicePlan erstellt.

Wenn VoiceCheck diese Meldung zum Lesen, Aktualisieren und Löschen von VoicePlans empfängt, finden die folgenden Validierungen statt:

  • Wenn der VoicePlan-Name in VoiceCheck nicht vorhanden ist, werden in der Antwort keine Details zurückgegeben.
  • Wenn der VoicePlan vorhanden ist, kann der Webservice lediglich den Namen des VoicePlan aktualisieren.
  • Ein VoicePlan kann auch dann gelöscht werden, wenn er auf eine Entität in VoiceCheck verweist.

VoicePlan-Details erstellen

REST-Webservice

WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan?_wadl

URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan

Methode: POST

Inhaltstyp: application/json;charset=UTF-8

Meldungstext: JSON gemäß Schema in der WADL-Datei. Die Elemente sind in der Eingabeelementetabelle beschrieben.

Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit Payload "VoicePlan gespeichert" zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus. Jeder andere HTTP-Statuscode als 200 oder 204 wird als Fehler gewertet. Wenn möglich, sollte das Hostsystem bei Fehlern Text zurückgeben.

POST-Parameter

VoicePlan-Datei mit gültigen Parametern im Text.

VOICEPLAN-DETAILS LESEN

REST-WEBSERVICE

WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan?_wadl

URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan/{planIdentifier}

Methode: GET

Inhaltstyp: application/json;charset=UTF-8

Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.

VOICEPLAN-DETAILS AKTUALISIEREN

WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan?_wadl

URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan/update/

Methode: POST

Inhaltstyp: application/json;charset=UTF-8

Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.

POST-Parameter

VoicePlan-Datei mit aktualisierten Parametern im Text.

VOICEPLAN-DETAILS LÖSCHEN

WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan?_wadl

URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceplan/{planIdentifier}

Methode: DELETE

Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.

EINGABEELEMENTE

EIGENSCHAFT TYP PFLICHT? DEFINITION VALIDIERUNG
planIdentifier

Zeichenfolge

Ja Name des VoicePlan Muss innerhalb von VoiceCheck eindeutig sein